home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 February / Macworld (1998-02).dmg / Shareware World / Utilities / Text Processing / ClipFiler2.4 / ReadMe - ClipFiler < prev    next >
Encoding:
Text File  |  1997-10-19  |  14.2 KB  |  180 lines  |  [ttro/ttxt]

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7. ClipFiler version 2.4, October 19, 1997 by Casey Fleser - cfleser@kagi.com
  8. Copyright © 1995-1997 Casey Fleser. ALL RIGHTS RESERVED
  9.  
  10. What does ClipFiler do?
  11.     After installing a ClipFiler FKEY, you may use that FKEY to quickly copy any text that you have selected to a file for later retrieval. 
  12.  
  13. FKEY?
  14.     An FKEY is a small program that runs when a special combination of keys are pressed simultaneously. For example, your computer comes with an FKEY installed to take snapshot of your screen and save it as a PICT in your root folder. To use this FKEY you would press the Command key, the Shift key and the "3" key. To use FKEYs, you will always use the Command, and Shift keys. The number key that you press in conjunction with command, and shift, determines which FKEY will be executed. For example, the Snapshot FKEY mentioned above is normally installed as key 3, and therefore Command-Shift-3 is the key combination used to execute it. If you have an FKEY installed at position 7, you would press Command-Shift-7, to execute that FKEY.
  15.  
  16. Installing ClipFiler:
  17.     CilpFiler comes with four different files. There are the "ClipFiler" control panel, "ClipFiler Guide", the "Register" application, and the "ReadMe - CilpFiler" document.
  18.     To install ClipFiler, copy the "ClipFiler" control panel to your Control Panels folder. The Control Panels folder is located in your System folder. Also copy the "ClipFiler Guide" to your Extension folder, which can also be found in your System folder. "ClipFiler Guide" is an interactive help system for ClipFiler using Apple Computer's Apple Guide help system. After you restart, the ClipFiler Guide will be available to you from the Help menu when the Finder is the active application.
  19.  
  20. Using the ClipFiler control panel:
  21. After opening the ClipFiler control panel, you will presented with the following screen:
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49. Installing a ClipFiler FKEY:
  50. To install a ClipFiler FKEY, first determine which position you would like to install it at, and then use the pop up menu to  select that position. You will notice that Key 1 and Key 2 are unavailable. This is because the MacOS has reserved Command-Shift-1 and Command-Shift-2 for Eject internal disk, and Eject external disk respectively. You may also see an icon next to an item that looks like the letter "F' next to a key. This icon designates an FKEY is present for that position. After you have selected the key that you would like to install, press the "Install Key" button. A grayed out ClipFiler icon will appear next to "Key #" in the pop up menu to indicate that the FKEY was successfully installed. The icon is grayed because it will not be available until you have restarted your computer.
  51.  
  52. A Note about upgrading ClipFiler:
  53. When upgrading from a previous version of ClipFiler, the old version should be removed. You may do this from the Control Panel using the "Remove Key" button,or alternately the ClipFiler suitcase may be manually removed by dragging it's suitcase from the Fonts folder. After this is finished the new FKEY may be installed as usual.
  54.  
  55. Setting the Clipping file's path:
  56. Note: Clipping file is the term used to denote a file that is used by a ClipFiler FKEY to store items it has copied. 
  57. The location of the Clipping file is shown next to the "Set Path..." button. To change this location, use the "Set Path..." button. The default location is your Desktop.
  58.  
  59. Setting the Clipping file's type and creator:
  60. Note: A file's type and creator information are used by the System to determine which application is used to open a file, and which format that is contained in the file.
  61. By default, ClipFiler creates SimpleText documents, which have type 'TEXT' and creator 'ttxt'. If you wish, you may change the type of document created by ClipFiler. If you do not know the type and creator for the type of file you would like, use the "Choose..." button to pick a document type that you would like, using a standard MacOS file dialog. If you already know the type and creator, you may type this information in the type and creator fields.
  62.  
  63. Creating a new file for each clipping:
  64. Beginning with v2.2, you make have ClipFiler create a new file for each clipping if you like. To do this, check the "Make a new file every time." checkbox.
  65. Note: If this option is checked, the new file dialog will default to the path, and name configured in the ClipFiler control panel, when the FKEY is invoked . 
  66.  
  67. Setting the Clipping Separator:
  68. The Clipping Separator is the text that is placed in between each item that you clip using a ClipFiler FKEY. You may change this to whatever you would like by typing the information in the Clipping Separator field. Starting with version 2.1, tokens were added to the Clipping separator, more on this later.
  69.  
  70. Making ClipFiler faster:
  71. Normally, when a ClipFiler FKEY is invoked, it switches to the Finder momentarily in order to force an application to place it's private clipboard on the System's clipboard. This is necessary, as some applications keep their clipboard private, and only by switching to another application can this private clipboard be retrieved. However, many applications use the System's clipboard, so no switching is required. If this is the case with the applications in which you use ClipFiler, you may select the "Faster, Less Compatible" option. Don't worry about this option causing your machine to crash. The worst that can happen, is that you will not get what you expect when you invoke the FKEY. If you find that ClipFiler is not copying the text that you have selected, make sure that this option is not set. 
  72.  
  73. Removing an FKEY:
  74. The "Remove Key" button will remove the FKEY that you have selected using the pop up menu. This button will remove any kind of FKEY, including a ClipFiler FKEY. It will not however remove an FKEY which has been installed in your System file. You may remove an FKEY installed in your System file with any resource editor, though tampering with your System is not for the faint of heart.
  75.  
  76. Using MacOS Drag and Drop text clipping files:
  77. Starting with version 2.3 ClipFiler may take advatage of the MacOS Drag and Drop style of text clipping files. To enable this feature, simply enter 'clpt' in the type field, and 'drag' in the creator field. Now when the FKEY is invoked a Drag and Drop text clipping file will be created.
  78.  
  79. Huh?
  80. If you have Apple Guide installed on your computer, pressing the "?" icon in the top right corner will bring up the ClipFiler help system, which can take you step by step through all of the items above.
  81.  
  82. For advanced users:
  83. ClipFiler v2.1 introduced tokens in the Clipping separator field. Tokens are patterns that are replaced when the FKEY is invoked. The following is a list of tokens that are currently supported by ClipFiler:
  84. $CLIP - The clipping.
  85. $SHORT_DATE - Current date using the short format is shown in the Date&Time control panel, e.g. 1/2/92.
  86. $MEDIUM_DATE - Current date using the medium format is shown in the Date&Time control panel, e.g. Thu, Jan 2, 1992.
  87. $LONG_DATE - Current date using the medium format is shown in the Date&Time control panel, e.g. Thursday, January 2, 1992.
  88. $SHORT_TIME - Current time without seconds, e.g. 4:56 PM
  89. $LONG_TIME - Current time with seconds, e.g. 4:56:12 PM
  90. $APP_NAME - The name of the application where the FKEY was invoked. 
  91. $PROMPT - Presents a dialog where you may enter the text you would like to replace $PROMPT with.
  92. Note: If $CLIP is not found in the separator the clipping is placed before the separator information.
  93. Example, Assuming the separator is defined as:
  94.  
  95. ---- Clipped on $SHORT_DATE at $LONG_TIME from $APP_NAME
  96. --> $PROMPT <--
  97. *** begin clip
  98. $CLIP
  99. end clip ***
  100.  
  101. If you were to invoke ClipFiler with the text "The quick brown fox." selected, on July 4th, 1996 at 12:00PM from SimpleText, and you typed "I Love ClipFiler." in the prompt dialog, the following would be appended to your Clipping file:
  102.  
  103. ---- Clipped on 7/4/96 at 12:00:00PM from SimpleText
  104. --> I Love ClipFiler. <--
  105. *** begin clip
  106. The quick brown fox.
  107. end clip ***
  108.  
  109. Here's an idea contributed by Jon Glass in his own words:
  110.  
  111. I don't know if you know this or not, but you can use the cusomizable 
  112. clipping separator to create html code. Here is how I customized it:
  113.  
  114. <HTML>
  115. <A HREF="$CLIP">$PROMPT</A><br> 
  116. </HTML>
  117.  
  118. I set the file type to TEXT and creator to MOSS. I also set it to not 
  119. create a new file. I now have a navigator file on my desktop with links 
  120. that I have gotten from my email, read-me files, or what-not. It is 
  121. beautifully simple, with no compatibility-risking inits like everybody 
  122. else uses. (or memory using, time taking scripts or macros)
  123.  
  124. Set the creator to MSIE if you use Internet Explorer.
  125.  
  126. A Note about Control Panels:
  127. There seems to be a bit of confusion about the differences between Control Panels and Extensions. I've heard from several people that are concerned that Control Panels can contribute to System instability since they behave as Extensions do. This is not always the case. Most Control Panels do not load themselves into memory at startup time as Extensions can (In reality, even Extension don't necessarily stay in memory). Only Control Panels with an INIT resource will be executed at startup time. ClipFiler does not have any INT resources. The only time that the Control Panel is in memory is while it is open. It does not patch anything, and should not conflict with any other software on your computer. Part of the confusion about ClipFiler may be the necessity of a restart after an FKEY is installed. In reality, this is only necessary to get the System to recognize the presence of the new suitcase in your Fonts folder. If you wish to avoid a restart, you can quit all running applications, drag the newly installed suitcaseout of your Fonts folder, and then drag it back in. The FKEY should now be recognized by the the System.
  128.  
  129. System Requirements:
  130. ClipFiler has been tested and will run on any Macintosh compatible computer with System 7.1 or greater installed.
  131.  
  132. Registration:
  133. ClipFiler is shareware, which means if you use it, you should send me US$10.
  134.  
  135. Pricing Info:
  136. • Single User US$10.
  137. • Site License US$250: covers all locations for your organization within a 160 kilometer radius of your site (100 miles).
  138. • World-Wide License US$1000: covers everyone in your organization on this planet, and others I suppose
  139.  
  140.     To register this program, open the "Register" program which accompanies ClipFiler. Fill out all of the necessary information, and send it via eMail, Snail-Mail, or Fax to Kagi Shareware. Kagi Shareware is a service run by Kee Nethery which handles registration for ClipFiler as well as a lot of other great shareware. The following explains a bit about the "Register" program and Kagi Shareware.
  141.  
  142.     If paying with Credit Card or First Virtual, you can eMail or fax the data to Kagi Shareware. Their eMail address is shareware@kagi.com and their fax number is +1 510 652-6589. You can either Copy the data from Register and paste into the body of an eMail message or you can Save the data to a file and you can attach that file to an eMail message. There is no need to compress the data file, it's already pretty small. If you have a fax modem, just Print the data to the Kagi fax number.
  143.  
  144.     Payments sent via eMail are processed within 3 to 4 days. You will receive an eMail acknowledgement when it is processed. Payments sent via fax take up to 10 days and if you provide a correct internet eMail address you will receive an eMail acknowledgement.
  145.  
  146.     If you are paying with Cash or USD Check you should print the data using the Register application and send it to the address shown on the form.
  147.  
  148.     You can pay with a wide variety of cash from different countries but at present if you pay via check, it must be a check drawn in US Dollars. Kagi Shareware cannot accept checks in other currencies, the conversion rate for non-USD checks is around USD 15 per check and that is just not practical.
  149.  
  150.     If you have a purchasing department, you can enter all the data into the Register program and then select Invoice as your payment method. Print three copies of the form and send it to your accounts payable people. You might want to highlight the line that mentions that they must include a copy of the form with their payment.
  151.  
  152.     Kagi Shareware can not invoice your company, you need to act on my behalf and generate the invoice and handle all the paperwork on your end.
  153.  
  154.     Please do not fax or eMail payment forms that indicate Cash, Check or Invoice as the payment method. Payments sent via postal mail take time to reach Kagi Shareware and then up to 10 days for processing. Again, if you include a correct eMail address, you will hear from Kagi Shareware when the form is processed.
  155.  
  156. Legal Bits:
  157. Distribution:
  158. ClipFiler may be freely distributed by any means, provided you don't charge for it. And provided it is unaltered and all of the files (ClipFiler, ClipFiler Guide, this ReadMe, and the Register) are included. But ClipFiler may not be distributed on CD without my permission. 
  159.  
  160. Liability:
  161. Casey Fleser will not be liable for any special, incidental, consequential, indirect or similar damages due to loss of data or any other reason. Which means although I've tested it very thoroughly, you still assume the risk for using this program.
  162.  
  163. Version History:
  164. v2.4 - Fixed a problem with the "Set Path..." dialog box when used with MacOS 8.
  165. v2.3 - Added the ability to use MacOS drag and drop text clipping files. Fixed a minor memory leak. Added ability to determine if installed FKEY is the latest version.
  166. v2.2 - Added the ability to create a new file for each clipping. Added some changes to improve the reliability of the Clipping operation.  Cleaned up the documentation a bit. Spelling boo-boos and such.
  167. v2.1 - Added tokens. 
  168. v2.0 - Added the ClipFiler control panel and Guide. Removed dependency on special resource inside the FKEY suitcases. Allow multiple FKEYs to be used, lots of preferences can be messed with via the control panel. 
  169. v1.3 - Added option to remove the "clip" string. Added ability to change the creator using the 'kinf' resource.
  170. v1.2 - ClipFiler now does copying for you (I kept forgetting to hit command-c). Now deals with applications that keep a private scrap.
  171. v1.1 - added a short sound when invoking the FKEY
  172. v1.0 - initial release
  173.  
  174. Acknowledgements:
  175. A special thanks to:
  176. • Florian Boyd who came up with the whole ClipFiler FKEY concept. 
  177. • Stephen Piper my Alpha tester!
  178. • Jerome Munnier for his encouragment and testing.
  179. • Susie Fleser for putting up with me, and encouraging me.
  180.